Fix tutorial example#3
Merged
Merged
Conversation
added 2 commits
September 18, 2014 14:25
The README and index.rst call a nonexistant get_name() method on a Device object. The correct call is get_stream_id().
The README and index.rst examples call a non-existant is_connected() method on Device. Rather than blindly changing the docs to match the code, the better solution in this case is to rename get_connected() to is_connected() to match the boolean return type of the method.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This fixes two bugs in the quick example in README and index.rst. Right now the examples, as-written, do not work because the method names do not exist.